remove freq parameter from gaps.completeness functions#236
Merged
Conversation
Updated the release notes for version 0.2.3 to reflect changes in function parameters and requirements.
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/api.rst.in
docs/whatsnewfor all changes. Includes link to the GitHub Issue with
:issue:`num`or this Pull Request with
:pull:`num`. Includes contributor nameand/or GitHub username (link with
:ghuser:`user`).gaps.completenessandgaps.completeness_scorerequire input to be a Series with DatetimeIndex, but also optionally accept afreqparameter for the input Series. If provided, thefreqparameter is used to compute the number of seconds between Series values. The path for calculation involves pandas functions (infer_freqandto_timedelta) that are inconsistent in their use of frequency strings. See this error for the possible result.pandas has a reported bug pandas-dev/pandas#36769 for several years and it appears unlikely that the behavior will be changed.
The number of seconds can be had from the Series index, so I'm removing the
freqparameter as a way to avoid the pandas issues.